/*
 * Copyright 2014 Alexey Plotnik
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.github.odiszapc.nginxparser;

/**
 * Comment. Example:
 * # Bla bla
 */
public class NgxComment extends NgxAbstractEntry
{

    public NgxComment(String comment)
    {
        if (comment.startsWith("#"))
        {
            comment = comment.substring(1);
        }
        if (!comment.endsWith(NgxDumper.LF))
        {
            comment += NgxDumper.LF;
        }
        getTokens().add(new NgxToken(comment));
    }

    /**
     * 不含"#",末尾会包含若干换行符。
     *
     * @return
     */
    @Override
    public String getValue()
    {
        return getName();
    }

    /**
     * 包含"#"
     *
     * @return
     */
    public String toString()
    {
        return "#" + getValue();
    }
}
